--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
vendor/lxmfy/docs/README.md dev (2bf00cb3) Text, 2.35 KB
LXMFy Docs
Documentation for the LXMFy bot framework. Built with Sphinx and the Furo theme.
Published docs: https://lxmfy.quad4.io
Languages: English (source) and Russian (T383838locales/ru/).
Building
T282828
poetry install --with dev
T8b949e# English (default)
make html
make epub
make latexpdf
make text
T8b949e# Russian
make html-ru
make epub-ru
make latexpdf-ru
make text-ru
T8b949e# Any language in locales/ (replace XX with language code)
make html-XX epub-XX latexpdf-XX text-XX
CI builds all formats for English and every language under T383838locales/.
Running locally
T282828
make serve
Serves English HTML at http://localhost:8000. For Russian, open T383838build/html/ru/index.html after T383838make html-ru.
Docker
Local/Development (BusyBox)
T282828
docker build -t lxmfy-docs .
docker run -p T79c0ff8080:8080 lxmfy-docs
Production (Nginx)
T282828
docker build -f Dockerfile.prod -t lxmfy-docs:prod .
docker run -p T79c0ff8080:8080 lxmfy-docs:prod
If using Podman, replace T383838docker with T383838podman.
Translations
Source files live in T383838source/ (reStructuredText). Translations are gettext T383838.po files in T383838locales/<lang>/LC_MESSAGES/.
Update existing translations
1. Edit English sources in T383838source/.
2. Extract strings:
T282828
make pot
3. Merge into existing T383838.po files:
T282828
msgmerge --update locales/ru/LC_MESSAGES/creating-bots.po build/gettext/creating-bots.pot
msgmerge --update locales/ru/LC_MESSAGES/api-reference.po build/gettext/api-reference.pot
msgmerge --update locales/ru/LC_MESSAGES/quick-start.po build/gettext/quick-start.pot
msgmerge --update locales/ru/LC_MESSAGES/index.po build/gettext/index.pot
4. Translate new or changed T383838msgstr entries in the T383838.po files.
5. Validate:
T282828
msgfmt --check locales/ru/LC_MESSAGES/*.po
6. Build and review:
T282828
make html-ru
Add a new language
1. Run T383838make pot.
2. Create T383838locales/<lang>/LC_MESSAGES/.
3. Copy each T383838build/gettext/*.pot to T383838locales/<lang>/LC_MESSAGES/*.po.
4. Set T383838Language: <lang> in each T383838.po header and translate all T383838msgstr fields.
5. Add the language to T383838source/index.rst under Languages.
6. Build with T383838make html-<lang>.
Adding a language only requires translation files and an index link; CI picks up new T383838locales/ entries automatically.
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────